feat(neon): `JsFunction::bind()` and `Object::prop()` #1056

dherman · 2024-07-08T18:15:07Z

This PR implements JsFunction::bind(), which creates a builder for calling a function using the Try{From,Into}Js traits.

let n = f.bind(&mut cx)
    .args((1, 2, 3))?
    .arg(4)?
    .arg_with(|cx| Ok(cx.number(5)))?
    .call::<f64>()?;

It also implements Object::prop(), which creates a builder for accessing object properties using the Try{From,Into}Js traits.

let x: f64 = obj
    .prop(&mut cx, "x")
    .get()?;

obj.prop(&mut cx, "y")
    .set(x)?;

let s: String = obj.prop(&mut cx, "toString")
    .bind()?
    .call()?;

Finally, it offers a shorthand convenience method Object::method(), which extracts an object property and binds it as a method:

let s: String = obj.method(&mut cx, "toString").call()?;

crates/neon/src/object/mod.rs

crates/neon/src/types_impl/function/mod.rs

crates/neon/src/types_impl/mod.rs

crates/neon/src/types_impl/function/mod.rs

crates/neon/src/object/mod.rs

crates/neon/src/types_impl/extract/with.rs

crates/neon/src/types_impl/mod.rs

…unction using the Try{From,Into}Js traits.

…expressively

…ing BindOptions::apply()

…ng non-functions with .bind()

…is already implemented for NeonResult

- tests for both strict and sloppy mode functions to show it works on primitives

…pe parameter other than for the key

…alling .bind(), since it's performed when calling .apply()

Co-authored-by: K.J. Valencik <kjvalencik@gmail.com>

…f a weird inconsistency between the callee being something other than a Handle vs the other args

…as the other impls

…cise typing - add PropOptions::this() to return the object - add PropOptions::prop() to enable assignment chaining

- BindOptions::exec() - rename BindOptions::apply() to BindOptions::call() - eliminate call_method_with() from API docs

…ation?

…h()` from docs

kjvalencik

The code and API look great! A couple small suggestions for the doc examples, but it's ready to go!

crates/neon/src/object/mod.rs

crates/neon/src/event/channel.rs

crates/neon/src/event/mod.rs

kjvalencik · 2024-10-02T13:02:21Z

crates/neon/src/types_impl/mod.rs

@@ -1158,6 +1120,7 @@ impl JsFunction {
    /// Calls this function.
    ///
    /// **See also:** [`JsFunction::call_with`].
+    #[deprecated(since = "TBD", note = "use `JsFunction::bind` instead")]


I don't think this one should be deprecated. It's the low level function that doesn't have the overhead of casting and deserialization. I think we should keep it.

Implements `JsFunction::bind()`, which creates a builder for calling a function using the `Try{From,Into}Js` traits. ```rust let n = f.bind(&mut cx) .args((1, 2, 3))? .arg(4)? .arg_with(|cx| Ok(cx.number(5)))? .call::<f64>()?; ``` Also implements `Object::prop()`, which creates a builder for accessing object properties using the `Try{From,Into}Js` traits. ```rust let x: f64 = obj .prop(&mut cx, "x") .get()?; obj.prop(&mut cx, "y") .set(x)?; let s: String = obj.prop(&mut cx, "toString") .bind()? .call()?; ``` Finally, it offers a shorthand convenience method `Object::method()`, which extracts an object property and binds it as a method: ```rust let s: String = obj.method(&mut cx, "toString").call()?; ``` --------- Co-authored-by: K.J. Valencik <kjvalencik@gmail.com>

dherman changed the title ~~feat(neon): JsFunction::bind()~~ feat(neon): JsFunction::bind() and Object::prop() Jul 9, 2024

dherman marked this pull request as ready for review July 9, 2024 17:42

dherman requested a review from kjvalencik July 10, 2024 22:18

kjvalencik requested changes Jul 12, 2024

View reviewed changes

kjvalencik reviewed Jul 12, 2024

View reviewed changes

crates/neon/src/types_impl/mod.rs Outdated Show resolved Hide resolved

dherman force-pushed the prop-options branch from ca0fce8 to 589fabc Compare September 9, 2024 00:59

kjvalencik reviewed Sep 10, 2024

View reviewed changes

crates/neon/src/types_impl/mod.rs Outdated Show resolved Hide resolved

kjvalencik reviewed Sep 10, 2024

View reviewed changes

crates/neon/src/types_impl/mod.rs Outdated Show resolved Hide resolved

kjvalencik requested changes Sep 13, 2024

View reviewed changes

dherman mentioned this pull request Sep 19, 2024

feat(neon): Add tokio async runtime support #1055

Merged

1 task

dherman and others added 20 commits September 27, 2024 14:09

Implement JsFunction::bind(), which creates a builder for calling a f…

5195a1b

…unction using the Try{From,Into}Js traits.

prettier

2dce48c

cargo fmt --all

e23492c

Add PropOptions and Object::prop() for accessing object properties …

0f8ff9e

…expressively

api doc formatting

a72ea6c

tweak test name for clarity

1369807

Optimization: only do the function type check of the callee when call…

9fa6a0d

…ing BindOptions::apply()

rebase: {Bind,Prop}Options take Cx instead of generic C: Context

5e26ba1

remove unnecessary sys::fun::call helper, and add test case for calli…

670837f

…ng non-functions with .bind()

prettier

1f8e108

cargo fmt --all

c2b4d5b

style: move long type parameter list to where-clause

8b09460

more style nits (where-clauses)

f1bc138

arg_with's closure doesn't need to require a Result, since TryIntoJs …

6253c56

…is already implemented for NeonResult

remove unnecessary unsafe: use .as_value() instead

9f13037

BindOptions::this() takes a TryIntoJs (and is therefore fallible)

d603630

- tests for both strict and sloppy mode functions to show it works on primitives

store object in PropOptions as a JsObject so it doesn't need a ty…

3305fc2

…pe parameter other than for the key

avoid the double-type-check of eagerly downcasting to function when c…

b779e37

…alling .bind(), since it's performed when calling .apply()

style: move the InvalidArg tag check to a match guard

a34531e

Co-authored-by: K.J. Valencik <kjvalencik@gmail.com>

argc can be usize now that we're not using the c++ backend

8f3c58e

dherman added 10 commits September 27, 2024 14:10

BindOptions::args_with() and equivalent BindOptions::args(With(...))

9050dc4

more readable logic for impl_arguments! and impl_into_arguments! macros

72bc8b8

move call_local into a method of ValueInternal, so there's less o…

e37382d

…f a weird inconsistency between the callee being something other than a Handle vs the other args

co-locate the impl of TryIntoArguments for With into the same module …

12d0217

…as the other impls

safety comment for .prop()

41c1376

PropOptions.set() returns self

6e44074

- put back the O: Object type parameter to PropOptions for more pre…

fd643a2

…cise typing - add PropOptions::this() to return the object - add PropOptions::prop() to enable assignment chaining

add PropOptions::set_with

7a4bbe3

eliminate uses of .get() and .set() in API docs

3d264bc

- Object::method()

7f1d108

- BindOptions::exec() - rename BindOptions::apply() to BindOptions::call() - eliminate call_method_with() from API docs

dherman force-pushed the prop-options branch from 83a0fbd to 7f1d108 Compare September 28, 2024 05:43

dherman added 6 commits September 27, 2024 22:58

experiment: can we use #[deprecated(since = "TBD")] for soft deprec…

84ee9ec

…ation?

allow fallible args_with

2158281

add BindOptions::construct()

b5a76b8

soft-deprecate JsFunction::{call, construct, call_with, construct_with}

39eaada

Remove .call(), .construct(), .call_with(), and `.construct_wit…

942fb50

…h()` from docs

API docs for JsFunction::bind()

46918d2

dherman requested a review from kjvalencik September 28, 2024 18:42

kjvalencik approved these changes Sep 30, 2024

View reviewed changes

crates/neon/src/object/mod.rs Show resolved Hide resolved

crates/neon/src/event/channel.rs Outdated Show resolved Hide resolved

crates/neon/src/event/mod.rs Outdated Show resolved Hide resolved

crates/neon/src/event/mod.rs Outdated Show resolved Hide resolved

KJ's suggested doc improvements

9bc02b6

dherman merged commit d7b27ef into main Oct 1, 2024
9 checks passed

dherman deleted the prop-options branch October 1, 2024 01:46

kjvalencik reviewed Oct 2, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(neon): `JsFunction::bind()` and `Object::prop()` #1056

feat(neon): `JsFunction::bind()` and `Object::prop()` #1056

dherman commented Jul 8, 2024 •

edited

Loading

kjvalencik left a comment

kjvalencik Oct 2, 2024

feat(neon): JsFunction::bind() and Object::prop() #1056

feat(neon): JsFunction::bind() and Object::prop() #1056

Conversation

dherman commented Jul 8, 2024 • edited Loading

kjvalencik left a comment

Choose a reason for hiding this comment

kjvalencik Oct 2, 2024

Choose a reason for hiding this comment

feat(neon): `JsFunction::bind()` and `Object::prop()` #1056

feat(neon): `JsFunction::bind()` and `Object::prop()` #1056

dherman commented Jul 8, 2024 •

edited

Loading